Skip to main content
GET
Get channel
Returns one channel by external id. Use this endpoint after the customer selects a channel to load its name, status, and CMS content for the storefront.
Requires a Fire spark access token obtained through token exchange.

Path parameters

Request

Response

The response wraps a single channel object in data. The shape matches list channels.

Channel fields

See list channels for the full schema, including cms_template_id and cms.
Use the channel id when loading menus and stores scoped to a specific ordering surface.

Error responses

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

External channel identifier.

Required string length: 1 - 64
Pattern: ^[a-zA-Z0-9_-]+$

Response

200 - application/json

Ok

data
object